7.4 查询外部用户角色详情
基本信息
Path： /api/v2/externalUserRole/queryById
Method： GET
接口描述：
请求参数
Query
根据角色ID查询
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| id | 必须 | 外部用户角色ID |
根据角色名称查询
| 参数名称 | 是否必须 | 示例 | 备注 | 其他信息 |
|---|---|---|---|---|
| name | 必须 | 外部用户角色名称 | ||
| userDirectoryId | 与userDirectoryName二选一 | 所属用户目录ID | userDirectoryId和userDirectoryName只传一个即可，都传时以userDirectoryId为准 | |
| userDirectoryName | 与userDirectoryId二选一 | 所属用户目录名称 | userDirectoryId和userDirectoryName只传一个即可，都传时以userDirectoryId为准 | |
| type | 必须 | 0 | 角色类型，0本地自定义角色，1外部导入角色 |
- 如果响应状态码为401且控制台【审计中心/设备安全日志】中存在接口攻击行为日志，处置原因为[SNORT]SNORT ACTION: BLOCK。说明是设备检测到了请求中存在攻击特征，触发了自动拦截。请检查name或者userDirectoryName参数中是否存在SQL或命令注入特征，如select、delete等关键字，如果存在请修改角色名或者用户目录名后重试。如需协助，可联系深信服客户服务热线：400-630-6430。
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | 错误码 | ||
| data | object | 必须 | 返回数据 | ||
| ├─ data | object[] | 必须 | 数据 | ||
| ├─├─ id | string | 必须 | 角色ID | ||
| ├─├─ userDirectoryId | string | 必须 | 所属用户目录ID | ||
| ├─├─ userDirectoryName | string | 必须 | 所属用户目录名 | ||
| ├─├─ name | string | 必须 | 角色名称 | ||
| ├─├─ description | string | 必须 | 描述 | ||
| ├─├─ type | number | 必须 | 角色类型，0本地自定义角色，1外部导入角色 | ||
| ├─├─ resourceList | object[] | 非必须 | 直接关联的应用和应用分类 | ||
| ├─├─├─ dataType | string | 非必须 | resource为应用，group为应用分类 | ||
| ├─├─├─ id | string | 非必须 | 应用/应用分类ID | ||
| ├─├─├─ name | string | 非必须 | 应用/应用分类名 | ||
| ├─├─├─ accessModel | string | 非必须 | 应用接入类型，WEB，L3VPN(应该分类无此字段) | ||
| ├─├─├─ description | string | 非必须 | 应用/应用分类描述 | ||
| ├─├─├─ status | string | 非必须 | 启用状态，0禁用，1启用 | ||
| ├─├─ userList | object[] | 非必须 | 适用对象-用户 | >=2.2.16后支持返回该字段 | |
| ├─├─├─ id | string | 非必须 | 用户id | ||
| ├─├─├─ name | string | 非必须 | 用户名 | ||
| ├─├─├─ displayName | string | 非必须 | 用户显示名 | ||
| ├─├─├─ path | string | 非必须 | 所属组织架构 | ||
| ├─├─ groupList | object[] | 非必须 | 适用对象-组织架构 | >=2.2.16后支持返回该字段 | |
| ├─├─├─ id | string | 非必须 | 组织架构id | ||
| ├─├─├─ name | string | 非必须 | 组织架构名 | ||
| ├─├─├─ path | string | 非必须 | 所属组织架构 | ||
| msg | string | 必须 | 错误消息 |
返回示例
{
"code": 0,
"data": {
"data": {
"id": "bebf3ee0-3ee9-11ed-ad05-a5bbb7baeda1",
"userDirectoryId": "106f3480-fce0-11ec-bbc4-270800df3cae",
"name": "外部角色名",
"resourceCount": 2,
"description": "",
"resourceList": [
{
"name": "应用分类1",
"status": 1,
"description": "描述",
"id": "66c78340-3efe-11ed-ad05-a5bbb7baeda1",
"dataType": "group"
},
{
"name": "隧道1",
"accessModel": "L3VPN",
"status": 1,
"level": "3",
"description": "",
"id": "022dd1d0-3f0f-11ed-804e-031ce827e394",
"iconId": "1",
"iconType": "font",
"iconPath": "/portal/preset_icon/1.png",
"dataType": "resource",
"subModel": "L3VPN",
"extendModel": ""
}
],
"inheritResource": {},
"type": 0,
"userList": [
{
"id": "5204fc10-ad0a-11ed-a413-e760e7fa79c8",
"name": "q1",
"path": "/",
"displayName": "q1"
},
{
"id": "5b308ca0-ad0a-11ed-a413-e760e7fa79c8",
"name": "q2",
"path": "/",
"displayName": "q2"
}
],
"groupList": [
{
"id": "014b1f80-acd7-11ed-bc74-15bff46e4d9b",
"name": "root",
"path": "/"
},
{
"id": "051e6ea0-acd7-11ed-bc74-15bff46e4d9b",
"name": "t1",
"path": "/t"
}
]
}
},
"msg": "请求成功",
"traceId": "012349f93d830c0f"
}
错误信息
| 错误提示 | 错误码 |
|---|---|
| 参数检查出错 | 10000001 |
| 用户目录不存在 | 77200001 |
| 操作失败，对象不存在或已被其他管理员删除 | 77200004 |